home *** CD-ROM | disk | FTP | other *** search
/ Cream of the Crop 20 / Cream of the Crop 20 (Terry Blount) (1996).iso / os2 / csinst.zip / install.hlp (.txt) < prev    next >
OS/2 Help File  |  1996-05-22  |  15KB  |  411 lines
  1.  
  2. ΓòÉΓòÉΓòÉ 1. Copyright ΓòÉΓòÉΓòÉ
  3.  
  4. (c) Copyright Janosch R. Kowalczyk, 1996.
  5.  
  6. myNstall is the universal small PM installation program for OS/2 from Janosch 
  7. R. Kowalczyk. 
  8.  
  9. All rights reserved. 
  10.  
  11. This program is Freeware. You can use this program for your own private 
  12. purposes, but you cannot change any of the contents with following exeptions: 
  13.  
  14.    1. Contents of the file INSTALL.DAT. 
  15.    2. You can use your own help file, but you MUST enclose following chapters 
  16.       from the existing INSTALL.HLP: 
  17.           Author 
  18.           Author's thanks 
  19.           Copyright (this chapter) 
  20.           Disclaimer 
  21.           Introduction 
  22.  
  23.  Please send all bug reports and improvement suggestions to the author. 
  24.  
  25.  
  26. ΓòÉΓòÉΓòÉ 2. Introduction ΓòÉΓòÉΓòÉ
  27.  
  28. The myNstall ([maj:]Nstall) is the universal smal installation PM-program. 
  29.  
  30. It uses control words to arrange the installation process and gives you the 
  31. interface to your own Rexx routines, so that you can design the installation 
  32. process with more flexibility as you are now able to. Of course you can omit 
  33. all these controls and work with the default values as delivered. 
  34.  
  35. If you want work without the control words, you can use this routine as is. It 
  36. copies almost all files (with exception of hidden and system files) from the 
  37. home directory into the selected destination directory. 
  38.  
  39. myNstall revision history 
  40.  
  41.  
  42. ΓòÉΓòÉΓòÉ 2.1. myNstall revision history ΓòÉΓòÉΓòÉ
  43.  
  44. These are the new features that are added for the version 1.01 Beta of 
  45. myNstall. 
  46.  
  47. Following keywords for the control file INSTALL.DAT was added: 
  48.  
  49.    1. WPS_ONLY_IF_EXIST= to hide/show the check box "Create WPS object only". 
  50.    2. WELCOME_BUTTON=OKCANCEL | OK to show in the Welcome message of your 
  51.       installation the buttons OK and Cancel or OK only. 
  52.    3. WELCOME_TITLE= to set the Title for this message. 
  53.    4. WELCOME= to set the message text. You can use multiple this keyword. 
  54.    5. START_REXX_BY_OPEN_WINDOW= to start your own Rexx routine at the start of 
  55.       installation process (Exit 1). 
  56.    6. START_REXX_BY_START_INSTALL= to call your own Rexx routine after you 
  57.       pressed the Install-Button but before the installation is starting (Exit 
  58.       2). 
  59.    7. START_REXX_BY_SUCCESSFUL= to start your own Rexx routine after the 
  60.       successfully installation (Exit 3). 
  61.    8. START_REXX_IF_FAILURE= to start your own Rexx routine if the installation 
  62.       is failed (Exit 4). 
  63.    9. START_REXX_BY_CLOSE_WINDOW= to start your own Rexx routine before you 
  64.       exit the installation process (Exit 5). 
  65.   10. DELETE_FILE= to delete a file from the destination directory before you 
  66.       start the installation process. You can use multiple this keyword. It is 
  67.       useful for the update installation. 
  68.   11. REMOVE_DIR= to delete a subdirectory from the destination directory 
  69.       before you start the installation process. You can use multiple this 
  70.       keyword. It is useful for the update installation. 
  71.  
  72.  These are the new features that are added for the version 1.02 Beta of 
  73.  myNstall. 
  74.  
  75.    1. DELETE_FILE_AFTER_INSTALLATION= to delete a file from the destination 
  76.       directory after successfully installation 
  77.    2. REMOVE_DIR_AFTER_INSTALLATION= to delete a subdirectory from the 
  78.       destination directory  after successfully installation. 
  79.  
  80.  
  81. ΓòÉΓòÉΓòÉ 3. System requirements ΓòÉΓòÉΓòÉ
  82.  
  83. myNstall requires approximately 200 kB (additional INSTALL.DAT) of disk space. 
  84. To use myNstall to install products, they must be the following on the 
  85. computer: 
  86.  
  87.      OS/2 version 2.x or higher, 
  88.  
  89.      Rexx support. 
  90.  
  91.  
  92. ΓòÉΓòÉΓòÉ 4. How does the myNstaller work? ΓòÉΓòÉΓòÉ
  93.  
  94. To use the myNstall copy following files into your products source 
  95. (installation) directory: 
  96.  
  97.      INSTALL.EXE 
  98.      INSTALL.HLP 
  99.      [INSTALL.DAT] 
  100.  
  101.  INSTALL.DAT is the control file with the keywords to control your installation 
  102.  process. You don't need this file, if you will not use its features. 
  103.  
  104.  The myNstall unpacks almost all files (with exception of files with attributes 
  105.  H (hidden) and S (system) from the home (source) directory into the current 
  106.  destination directory. 
  107.  
  108.  See OS/2 UNPACK command for more info. 
  109.  
  110.  Note:  If the current destination directory does not exist, it will be 
  111.  created. You will be prompted for the confirmation. 
  112.  
  113.  The description of the WPS objects is situated in the file INSTALL.DAT. The 
  114.  description records must be enclosed in parenthesis ( ). If you will be 
  115.  creating a folder for other objects, it must be placed at the beginning of the 
  116.  listing. For the syntax see the parameter list of the REXX function 
  117.  SysCreateObject. 
  118.  
  119.  Note:  You can only use one (1) line for one (1) description record. i.e.: 
  120.  
  121.           /*------(start WPS objects)-----*/
  122.           ("WPFolder", title, location, associations, "r")
  123.           ("WPProgram", title, location, associations, "r")
  124.              other descriptions record
  125.              other descriptions record
  126.           /*------(end WPS objects)-----*/
  127.  
  128.  See chapter Control words (keywords) in this file for more information. 
  129.  
  130.  
  131. ΓòÉΓòÉΓòÉ 5. Control words summary ΓòÉΓòÉΓòÉ
  132.  
  133. The following are keywords to control the installation process: 
  134.  
  135.    1. DESTINATION=destination_directory_path 
  136.    2. WPS_ONLY_IF_EXIST=file_name 
  137.    3. WELCOME=welcome_message 
  138.    4. WELCOME_TITLE=message_title 
  139.    5. WELCOME_BUTTON={OK | OKCANCEL} 
  140.    6. START_REXX_BY_OPEN_WINDOW=rexxcall 
  141.    7. START_REXX_BY_START_INSTALL=rexxcall 
  142.    8. START_REXX_BY_SUCCESSFUL=rexxcall 
  143.    9. START_REXX_BY_FAILURE=rexxcall 
  144.   10. START_REXX_BY_CLOSE_WINDOW=rexxcall 
  145.   11. DEST_PATH (used by SysCreateObject and your own Rexx) 
  146.   12. HOMEDIR (to be used by your own Rexx) 
  147.   13. DELETE_FILE 
  148.   14. REMOVE_DIR 
  149.  
  150.  See chapter Control words (keywords) for more details. 
  151.  
  152.  
  153. ΓòÉΓòÉΓòÉ 6. Control words (keywords) ΓòÉΓòÉΓòÉ
  154.  
  155. Note:  You can write the keywords into the file INSTALL.DAT in any order! 
  156.  
  157. In the follwing chapters are described keywords which you can use in the 
  158. control file INSTALL.DAT. 
  159.  
  160. Remember:  you can omit all these controls and work with default values only. 
  161.  
  162.  
  163. ΓòÉΓòÉΓòÉ 6.1. Destination path ΓòÉΓòÉΓòÉ
  164.  
  165. DESTINATION=destination_directory_path 
  166.  
  167. This keyword identifies the record from file INSTALL.DAT which sets the name of 
  168. the standard destination directory. 
  169.  
  170. If you omit this name, the root directory of the drive C: will be used. 
  171.  
  172. You should omit the leading and ending backslashes and the drive character. 
  173.  
  174. Default value:   root directory of the drive C: (drive C: is always the default 
  175. drive. Everybody has the drive C: - isn't?). 
  176.  
  177. Example:  DESTINATION=TOOLS\INSTALL 
  178.  
  179.  
  180. ΓòÉΓòÉΓòÉ 6.2. Create WPS object only ΓòÉΓòÉΓòÉ
  181.  
  182. WPS_ONLY_IF_EXIST=file_name 
  183.  
  184. The Installer is able to recreate the damaged WPS-Objects for your 
  185. installation. It does this, if the Check Box Create WPS objects only is 
  186. selected. But it is not necessary to show this box if the user is doing his 
  187. first installation. You can hide this Check Box for the installation window, if 
  188. you use this keyword. This box will be showed, if the file file_name is present 
  189. in the destination directory. 
  190.  
  191. Default value:  no - the check box will be showed 
  192.  
  193. Example:  WPS_ONLY_IF_EXIST=GREED.EXE 
  194.  
  195.  
  196. ΓòÉΓòÉΓòÉ 6.3. Welcome keywords ΓòÉΓòÉΓòÉ
  197.  
  198. These keywords help you to personify the start of the install procedure. There 
  199. are 3 WELCOME-keywords: 
  200.  
  201.    1. WELCOME=welcome_message 
  202.  
  203.       This keyword allows you to show the text of welcome_message before your 
  204.       installation starts. You can use multiple WELCOME= keywords for one 
  205.       message. Each WELCOME= message gives you a new line in the message box. 
  206.       Additionally  you can use '\n' (like C) in the message line for Line 
  207.       Feed. 
  208.  
  209.       Note:  You must have used at least one WELCOME= message before you can 
  210.       use the WELCOME_TITLE and WELCOME_BUTTON keywords. 
  211.  
  212.       Default value:   No - no message box. 
  213.  
  214.       Example: 
  215.  
  216.       WELCOME=Welcome to the Installation of "GREED"\nVersion 2.0 Beta.\n\n 
  217.  
  218.